Skip to content

Nuke Docs via GithubActions + add compat for CairoMakie v0.11, v0.12 #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 77 commits into from
Nov 2, 2024

Conversation

navidcy
Copy link
Member

@navidcy navidcy commented Aug 20, 2024

This PR closes #157. Also drops the previews and adds some more compat entries for CairoMakie. Closes #161.

@navidcy navidcy added the documentation Improvements or additions to documentation label Aug 20, 2024
@navidcy navidcy changed the title Disable docs previews Disable docs previews + add compat for CairoMakie v0.11, v0.12 Aug 20, 2024
@simone-silvestri
Copy link
Collaborator

Is there a way we can check the results without pushing the preview?

@navidcy navidcy changed the title Disable docs previews + add compat for CairoMakie v0.11, v0.12 Nuke Docs via GithubActions + Disable docs previews + add compat for CairoMakie v0.11, v0.12 Aug 20, 2024
@navidcy
Copy link
Member Author

navidcy commented Aug 20, 2024

Is there a way we can check the results without pushing the preview?

No.

We should enable the preview when we want for particular PRs... We don't want previews for every random PR because things will get out of hand.

@glwagner
Copy link
Member

glwagner commented Aug 20, 2024

Is there a way we can check the results without pushing the preview?

Also I don't think we should use the example to assess PRs, they take way too long to run. We have a lot of development to do so we need a way to assess PRs more quickly...

We can put problems that are similar to the example (but cheaper) in the tests, and create plots from them if we want (ClimaAtmos does something similar).

Copy link

codecov bot commented Aug 20, 2024

Codecov Report

Attention: Patch coverage is 0% with 74 lines in your changes missing coverage. Please review.

Project coverage is 0.00%. Comparing base (8796b45) to head (7ceabae).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...rc/OceanSeaIceModels/CrossRealmFluxes/radiation.jl 0.00% 16 Missing ⚠️
...dels/CrossRealmFluxes/latitude_dependent_albedo.jl 0.00% 12 Missing ⚠️
src/OceanSeaIceModels/PrescribedAtmospheres.jl 0.00% 10 Missing ⚠️
src/OceanSimulations/OceanSimulations.jl 0.00% 10 Missing ⚠️
...Models/CrossRealmFluxes/atmosphere_ocean_fluxes.jl 0.00% 8 Missing ⚠️
src/OceanSeaIceModels/ocean_sea_ice_model.jl 0.00% 8 Missing ⚠️
...nSeaIceModels/CrossRealmFluxes/tabulated_albedo.jl 0.00% 6 Missing ⚠️
src/DataWrangling/JRA55.jl 0.00% 4 Missing ⚠️
Additional details and impacted files
@@          Coverage Diff          @@
##            main    #156   +/-   ##
=====================================
  Coverage   0.00%   0.00%           
=====================================
  Files         31      32    +1     
  Lines       1739    1779   +40     
=====================================
- Misses      1739    1779   +40     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@glwagner
Copy link
Member

Is there a way we can check the results without pushing the preview?

No.

We should enable the preview when we want for particular PRs... We don't want previews for every random PR because things will get out of hand.

An alternative though is if @simone-silvestri wants to take responsibility for deleting the old push previews right?

@simone-silvestri
Copy link
Collaborator

Do you mean deleting the previews after the PR is merged? That could be a nice idea. Maybe we can merge this PR and I can investigate if it is possible to do this in an automatic manner

@glwagner
Copy link
Member

Do you mean deleting the previews after the PR is merged? That could be a nice idea. Maybe we can merge this PR and I can investigate if it is possible to do this in an automatic manner

We already attempt to do it automatically, but it doesn't always work. So previously, @navidcy took responsibility for monitoring the repo and going in and manually deleting things when it filled up (similar to what I do with the buildkite builds). But @navidcy eventually decided it was too much work. However you can decide to take this responsibility if you want to keep the previews. I don't think you'll be able to completely automate the process.

@simone-silvestri
Copy link
Collaborator

Ok, I can take responsibility for that and see how it goes.

@navidcy
Copy link
Member Author

navidcy commented Aug 21, 2024

There is a way to do it automatically if the gh-pages are in the same repo. It's documented in the documentation of Documenter.jl and actually the example there is from a CliMA repo!! However, it doesn't work for when the Docs live in a different repo. I tried a lot and also asked CliMA to help me to make it work for when the docs are deployed in a different repo but I never managed to do it. If you figure how to do that it'd be great!!

@navidcy
Copy link
Member Author

navidcy commented Aug 21, 2024

Btw, why are the examples still haven't run?

@navidcy
Copy link
Member Author

navidcy commented Aug 21, 2024

@simone-silvestri simone-silvestri added the build docs Add this label to built the docs in a PR label Aug 21, 2024
@simone-silvestri
Copy link
Collaborator

The Run examples label triggers the build, without that the examples are not run. I have added the label but you have to commit again to trigger the pipeline

@navidcy
Copy link
Member Author

navidcy commented Aug 22, 2024

@simone-silvestri simone-silvestri mentioned this pull request Aug 22, 2024
@simone-silvestri
Copy link
Collaborator

I don't think they were deleted. maybe restarting the build will download them correctly?

@navidcy
Copy link
Member Author

navidcy commented Nov 1, 2024

ERROR: LoadError: LoadError: Number of threads per block exceeds kernel limit (1024 > 896).
in expression starting at /central/scratch/esm/slurm-buildkite/climaocean-examples/729/climaocean-examples/docs/src/literated/near_global_ocean_simulation.md:2
when executing the following code block from inputfile /central/scratch/esm/slurm-buildkite/climaocean-examples/729/climaocean-examples/examples/near_global_ocean_simulation.jl

date = DateTimeProlepticGregorian(1993, 1, 1)
set!(ocean.model, T=ECCOMetadata(:temperature; dates=date), S=ECCOMetadata(:salinity; dates=date))

https://buildkite.com/clima/climaocean-examples/builds/729#0192e4d0-1ff4-4c6d-9570-c163ce343a40/189-1417

Any idea what that is and how to avoid it? On tartarus that line went through fine!

@navidcy
Copy link
Member Author

navidcy commented Nov 1, 2024

I have some progress!

julia> Tn
Observable(1440×600×1 Field{Center, Center, Center} on ImmersedBoundaryGrid on CPU
├── grid: 1440×600×40 ImmersedBoundaryGrid{Float64, Periodic, Bounded, Bounded} on CPU with 7×7×7 halo
├── boundary conditions: FieldBoundaryConditions
│   └── west: Periodic, east: Periodic, south: ZeroFlux, north: ZeroFlux, bottom: Nothing, top: Nothing, immersed: ZeroFlux
├── indices: (:, :, 40:40)
└── data: 1454×614×1 OffsetArray(::Array{Float32, 3}, -6:1447, -6:607, 40:40) with eltype Float32 with indices -6:1447×-6:607×40:40
    └── max=31.2508, min=-1.96045, mean=0.476186)


julia> heatmap(Tn)

[1626384] signal (11.128): Segmentation fault
in expression starting at REPL[56]:1
Segmentation fault (core dumped)

@glwagner
Copy link
Member

glwagner commented Nov 1, 2024

ERROR: LoadError: LoadError: Number of threads per block exceeds kernel limit (1024 > 896). in expression starting at /central/scratch/esm/slurm-buildkite/climaocean-examples/729/climaocean-examples/docs/src/literated/near_global_ocean_simulation.md:2 when executing the following code block from inputfile /central/scratch/esm/slurm-buildkite/climaocean-examples/729/climaocean-examples/examples/near_global_ocean_simulation.jl

date = DateTimeProlepticGregorian(1993, 1, 1)
set!(ocean.model, T=ECCOMetadata(:temperature; dates=date), S=ECCOMetadata(:salinity; dates=date))

https://buildkite.com/clima/climaocean-examples/builds/729#0192e4d0-1ff4-4c6d-9570-c163ce343a40/189-1417

Any idea what that is and how to avoid it? On tartarus that line went through fine!

I think you need to consider a smaller problem / grid

@navidcy navidcy merged commit 985244e into main Nov 2, 2024
8 checks passed
@navidcy navidcy deleted the ncc/disable-doc-previews branch November 2, 2024 01:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build docs Add this label to built the docs in a PR documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs built Examples do not show in the docs
3 participants